Improve troubleshooting guide for issues switching from Docker Engine #34764

nitishfy · 2022-07-01T19:52:09Z

Note
The approach that I followed was to add a small paragraph at the beginning of the page (https://kubernetes.io/docs/tasks/debug/debug-cluster/) Cluster not starting which will guide the users to navigate to the following page (https://kubernetes.io/docs/tasks/administer-cluster/migrating-from-dockershim/) to understand more about the error: Error: failed to parse kubelet flag: unknown flag: --network-plugin

Also, Before upgrading to Kubernetes 1.24, it is essential to go through Urgent Upgrade Notes . This could also be seen from @sftim comment on the issue that this PR is fixing.

Please feel free to suggest changes if necessary.

netlify · 2022-07-01T20:04:30Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`8187003`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/63e3cc97870d220007aad079
😎 Deploy Preview	https://deploy-preview-34764--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

content/en/docs/tasks/debug/debug-cluster/_index.md

divya-mohan0209

Few grammatical nits + incorporated suggestions from @Sea-n

content/en/docs/tasks/debug/debug-cluster/_index.md

nitishfy · 2022-07-04T07:45:52Z

Hi @divya-mohan0209 @Sea-n , Thank you for suggesting the changes. The following changes have been added now.

kbhawkey · 2022-07-11T00:49:19Z

content/en/docs/tasks/debug/debug-cluster/_index.md

@@ -14,7 +14,23 @@ problem you are experiencing. See
 the [application troubleshooting guide](/docs/tasks/debug/debug-application/) for tips on application debugging.
 You may also visit the [troubleshooting overview document](/docs/tasks/debug/) for more information.

+ Before upgrading to Kubernetes 1.24 , please go through [Urgent Upgrade Notes](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.24.md#urgent-upgrade-notes).


nit: You can remove the word, 'please'.
Before you upgrade to Kubernetes 1.24, review the Urgent Upgrade Notes.

You should incorporate this feedback @nitishkumar06

Also, we ought to remove this line on the dev-1.25 branch, once that branch has merged in this update.

sftim

I like the intent here, but the advice is misleading enough that we should not merge this as-is.

@nitishkumar06 do you understand how to fix those concerns?

sftim · 2022-07-11T08:48:43Z

content/en/docs/tasks/debug/debug-cluster/_index.md

+kubelet --help | grep network-plugin
+```
+
+*Note: If you get the following error after upgrading to Kubernetes 1.24, go through the [Migrating from dockershim](/docs/tasks/administer-cluster/migrating-from-dockershim/) guide to get a better understanding of how to resolve this error.*


Suggested change

*Note: If you get the following error after upgrading to Kubernetes 1.24, go through the [Migrating from dockershim](/docs/tasks/administer-cluster/migrating-from-dockershim/) guide to get a better understanding of how to resolve this error.*

If you get the following error after upgrading to Kubernetes 1.24, and you were previously using Docker Engine as your container runtime, go through the [Migrating from dockershim](/docs/tasks/administer-cluster/migrating-from-dockershim/) guide.

sftim · 2022-07-11T08:48:56Z

content/en/docs/tasks/debug/debug-cluster/_index.md

+
+*Note: If you get the following error after upgrading to Kubernetes 1.24, go through the [Migrating from dockershim](/docs/tasks/administer-cluster/migrating-from-dockershim/) guide to get a better understanding of how to resolve this error.*
+
+```shell


This is not a shell script. Omit shell here.

This issue is still not addressed.

sftim · 2022-07-11T08:49:27Z

content/en/docs/tasks/debug/debug-cluster/_index.md

+To start your cluster, run the following command:
+
+```shell
+kubelet --help | grep network-plugin
+```


This is not a command that starts your cluster

Thanks @sftim , I'll push the new changes now.

@sftim The new changes have been pushed. I've deleted the following command which is wrong and believe it can go without mentioning on "How to start a cluster" since it's error resolving page and not "guide page"

This is incorrect
You do not start your cluster with kubelet --help | grep network-plugin

/hold
Holding until this is corrected

content/en/docs/tasks/debug/debug-cluster/_index.md

nitishfy · 2022-07-14T19:14:37Z

WDYT of this change now? @sftim

sftim · 2022-07-15T00:29:59Z

/retitle Improve troubleshooting guide for issues switching from Docker Engine

sftim · 2022-07-15T00:31:01Z

To me, #34764 (comment) is only barely a nit. It really would be better to remove “please”; that word isn't right for a troubleshooting guide.

However, this change is much more right than wrong.
/lgtm

k8s-ci-robot · 2022-07-15T00:31:19Z

LGTM label has been added.

Git tree hash: 0f4c2bfcef3c6289f1170bc6dca3e506eb6ea149

nitishfy · 2022-07-15T16:45:47Z

@sftim Ahan sorry! I forgot to do that. I'll do it now.

k8s-ci-robot · 2022-07-15T16:50:43Z

New changes are detected. LGTM label has been removed.

nitishfy · 2022-07-15T16:52:00Z

@sftim The requested changes are applied now. I think this PR is ready to be merged. WDYT?

Sea-n · 2022-09-20T06:18:59Z

Hey @nitishkumar06,

It's been a while since the last update, should we close this PR?

If you want to change the target branch to dev-1.24, it's not necessary to open a new PR, just see this tutorial.

nitishfy · 2022-09-26T09:43:55Z

Hey @Sea-n @sftim , Do you have further suggestions to go for? I believe we can consider this PR as approved if no one has much suggestions regarding the same.

reylejano · 2022-09-30T20:22:26Z

content/en/docs/tasks/debug/debug-cluster/_index.md

+Before upgrading to Kubernetes 1.24, please go through [Urgent Upgrade Notes](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.24.md#urgent-upgrade-notes).
+


The current main branch is for 1.25
I'm also ok with this line not being in the top of this page as there is no other content/context around troubleshooting upgrades.
Maybe a warning like this (sans version) can go in the Upgrade a Cluster. A similar sentence is already in the Upgrading kubeadm clusters page

Suggested change

Before upgrading to Kubernetes 1.24, please go through [Urgent Upgrade Notes](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.24.md#urgent-upgrade-notes).

Before upgrading to Kubernetes 1.24, please go through [Urgent Upgrade Notes](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.24.md#urgent-upgrade-notes).

@reylejano Thank you for the suggestions! I'd be committing the changes soon.

reylejano · 2022-09-30T20:23:52Z

Hey @Sea-n @sftim , Do you have further suggestions to go for? I believe we can consider this PR as approved if no one has much suggestions regarding the same.

@nitishkumar06
This PR is not considered approved as there are comments not addressed and an incorrect instruction on how to start a cluster

reylejano · 2022-09-30T20:26:00Z

If you want to change the target branch to dev-1.24, it's not necessary to open a new PR, just see this tutorial.

The target branch for the 1.24 docs is the release-1.24 branch

nitishfy · 2022-10-12T15:36:08Z

@reylejano Please checkout the file changes in the latest commit.

k8s-ci-robot · 2023-01-01T12:06:09Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from sftim by writing /assign @sftim in a comment. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

content/en/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

nitishfy · 2023-01-01T12:23:56Z

@sftim @reylejano @Sea-n Kindly take a look at the changes now.

divya-mohan0209

Left some suggestions. WDYT?

divya-mohan0209 · 2023-01-15T08:53:26Z

content/en/docs/tasks/administer-cluster/cluster-upgrade.md

@@ -27,6 +27,8 @@ the documentation for the version of Kubernetes that you plan to upgrade to.

 ## Upgrade approaches

+please go through [Urgent Upgrade Notes](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.24.md#urgent-upgrade-notes).


I've a couple of suggestions here.

I'd recommend not using the word please here. 2. We're linking to the 1.24 upgrade notes for a particular reason right? We should say why we're asking our audience to go through the guide as a form of context setting.

divya-mohan0209 · 2023-01-15T09:05:02Z

content/en/docs/tasks/debug/debug-cluster/_index.md


+## {{< note >}} 
+*Note: Due to change in CNI, the `kubelet` binary might not recognize `--network-plugin` flag even after passing to `kubelet` which leads to the following error:


IMO, this could be phrased better. WDYT?

Suggested change

*Note: Due to change in CNI, the `kubelet` binary might not recognize `--network-plugin` flag even after passing to `kubelet` which leads to the following error:

*Note: Starting 1.24, since management of the CNI is no longer in scope for kubelet, the `--network-plugin` command line parameter has been removed from the binary and will throw the following error, if used:

As per @reylejano suggested here, I've omitted this line.

content/en/docs/tasks/debug/debug-cluster/_index.md

kbhawkey · 2023-02-20T23:12:51Z

Hello @nitishkumar06 .
I think it makes sense to close this pull request. You can always create another PR with updated changes. Thanks.
/close

k8s-ci-robot · 2023-02-20T23:12:56Z

@kbhawkey: Closed this PR.

In response to this:

Hello @nitishkumar06 .
I think it makes sense to close this pull request. You can always create another PR with updated changes. Thanks.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

nitishfy · 2023-02-21T02:49:18Z

How does it make sense to open a new PR? This PR already had the suggested changes pushed. We were looking forward to getting a review from the maintainers before proceeding further rather than closing this one.

kbhawkey · 2023-02-21T13:29:05Z

Hello @nitishkumar06 . You can always reopen a pull request. Do you want to mark this PR as a draft or are the changes ready to merge?

tengqm

I'm not sure why we have removed the heading 2 at line 29.
I'm not sure why we add a heading 3 at line 317.
Line 319-325 is a note, that is fine. But line 319 and 325 are marked heading 2?
Why line 320 starts with a '*'?
Can we wrap the lines inside the note?

nitishfy · 2023-02-22T14:14:58Z

This workspace kind of looks messed up - Hence created a new PR: #39625

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. language/en Issues or PRs related to English language labels Jul 1, 2022

k8s-ci-robot requested review from davidopp and divya-mohan0209 July 1, 2022 19:52

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jul 1, 2022

Sea-n reviewed Jul 2, 2022

View reviewed changes

content/en/docs/tasks/debug/debug-cluster/_index.md Outdated Show resolved Hide resolved

divya-mohan0209 previously requested changes Jul 4, 2022

View reviewed changes

content/en/docs/tasks/debug/debug-cluster/_index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/debug/debug-cluster/_index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/debug/debug-cluster/_index.md Outdated Show resolved Hide resolved

nitishfy requested review from divya-mohan0209 and Sea-n July 5, 2022 15:35

kbhawkey reviewed Jul 11, 2022

View reviewed changes

sftim reviewed Jul 11, 2022

View reviewed changes

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 11, 2022

sftim reviewed Jul 11, 2022

View reviewed changes

content/en/docs/tasks/debug/debug-cluster/_index.md Outdated Show resolved Hide resolved

nitishfy mentioned this pull request Jul 14, 2022

REQUEST: New membership for <Nitish Kumar> kubernetes/org#3557

Closed

9 tasks

k8s-ci-robot changed the title ~~Cluster not starting error after Kubernetes 1.24 resolved~~ Improve troubleshooting guide for issues switching from Docker Engine Jul 15, 2022

k8s-ci-robot assigned sftim Jul 15, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 15, 2022

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 15, 2022

k8s-ci-robot requested a review from sftim July 15, 2022 16:50

reylejano reviewed Sep 30, 2022

View reviewed changes

Cluster not starting after Kubernetes 1.24 resolved

49b244c

nitishfy force-pushed the K8sCluster branch from b7f2e3f to 864c986 Compare October 12, 2022 15:35

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 12, 2022

Improve troubleshooting guide for issues switching from docker Engine

493d084

nitishfy force-pushed the K8sCluster branch from 864c986 to 493d084 Compare October 12, 2022 15:40

Merge branch 'kubernetes:main' into K8sCluster

41ea80d

new changes applied

d0ec0bd

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 1, 2023

divya-mohan0209 requested changes Jan 15, 2023

View reviewed changes

nitishfy added 2 commits February 8, 2023 21:35

Merge branch 'kubernetes:main' into K8sCluster

bca985e

changes applied

8187003

k8s-ci-robot closed this Feb 20, 2023

tengqm reviewed Feb 21, 2023

View reviewed changes

nitishfy deleted the K8sCluster branch February 22, 2023 13:56

nitishfy mentioned this pull request Feb 22, 2023

Update documentation to reflect removal of --network-plugin command line parameter in Kubelet 1.24 #39625

Closed

	Note: If you get the following error after upgrading to Kubernetes 1.24, go through the [Migrating from dockershim](/docs/tasks/administer-cluster/migrating-from-dockershim/) guide to get a better understanding of how to resolve this error.
	If you get the following error after upgrading to Kubernetes 1.24, and you were previously using Docker Engine as your container runtime, go through the [Migrating from dockershim](/docs/tasks/administer-cluster/migrating-from-dockershim/) guide.


		Note: If you get the following error after upgrading to Kubernetes 1.24, go through the [Migrating from dockershim](/docs/tasks/administer-cluster/migrating-from-dockershim/) guide to get a better understanding of how to resolve this error.

		```shell

		Before upgrading to Kubernetes 1.24, please go through [Urgent Upgrade Notes](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.24.md#urgent-upgrade-notes).

		@@ -27,6 +27,8 @@ the documentation for the version of Kubernetes that you plan to upgrade to.

		## Upgrade approaches

		please go through [Urgent Upgrade Notes](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.24.md#urgent-upgrade-notes).


		## {{< note >}}
		*Note: Due to change in CNI, the `kubelet` binary might not recognize `--network-plugin` flag even after passing to `kubelet` which leads to the following error:

	*Note: Due to change in CNI, the `kubelet` binary might not recognize `--network-plugin` flag even after passing to `kubelet` which leads to the following error:
	*Note: Starting 1.24, since management of the CNI is no longer in scope for kubelet, the `--network-plugin` command line parameter has been removed from the binary and will throw the following error, if used:

Improve troubleshooting guide for issues switching from Docker Engine #34764

Improve troubleshooting guide for issues switching from Docker Engine #34764

Conversation

nitishfy commented Jul 1, 2022

netlify bot commented Jul 1, 2022 • edited Loading

✅ Pull request preview available for checking

divya-mohan0209 left a comment

Choose a reason for hiding this comment

nitishfy commented Jul 4, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nitishfy commented Jul 14, 2022

sftim commented Jul 15, 2022

sftim commented Jul 15, 2022

k8s-ci-robot commented Jul 15, 2022

nitishfy commented Jul 15, 2022

k8s-ci-robot commented Jul 15, 2022

nitishfy commented Jul 15, 2022

Sea-n commented Sep 20, 2022

nitishfy commented Sep 26, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reylejano commented Sep 30, 2022 • edited Loading

reylejano commented Sep 30, 2022

nitishfy commented Oct 12, 2022

k8s-ci-robot commented Jan 1, 2023

nitishfy commented Jan 1, 2023

divya-mohan0209 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kbhawkey commented Feb 20, 2023

k8s-ci-robot commented Feb 20, 2023

nitishfy commented Feb 21, 2023

kbhawkey commented Feb 21, 2023

tengqm left a comment

Choose a reason for hiding this comment

nitishfy commented Feb 22, 2023

netlify bot commented Jul 1, 2022 •

edited

Loading

reylejano commented Sep 30, 2022 •

edited

Loading